Salesforce UX API
TMF-639 GET DELETE POST ( Change MSISDN for Akamai)
CASE 1 Unitary Test (List All Device Interfaces of Akamai)
This operation list the interface inventory of device from Akamai.
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/resourceurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| operation | string | listAllDeviceInterfaces | Y |
| X-Asavie-Account-Id | string | Id of the account to operate in | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| id | string | Id of device to search | Y |
Request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/resource?id=aa8b849f-da7c-4f70-8e00-4a28dda43fc5' \
--header 'X-Correlation-Id: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'client_id: abcde' \
--header 'client_secret: 12345' \
--header 'operation: listAllDeviceInterfaces' \
--header 'X-Asavie-Account-Id: a005e16a-2fc4-4320-a3fb-545ae52f5958'Response
[
{
"name": "Interface Name", //name
"id": "d489e8c5-0956-4b42-ab5f-8153e01ad5eb", //id
"resourceCharacteristic": [
{
"name": "account_id", //account_id
"value": "a005e16a-2fc4-4320-a3fb-545ae52f5958"
}
],
"activationFeature": [
{
"featureCharacteristic": [
{
"name": "apn_id", //apn_id
"value": "4534-3534-434"
},
{
"name": "apn_operator", //apn_operator
"value": "Operator"
},
{
"name": "interface_type", //interface_type
"value": "type"
},
{
"name": "static_ip", //static_ip
"value": "125.254.236.325"
},
{
"name": "access_ip", //access_ip
"value": "125.254.236.325"
},
{
"name": "sim_number", //sim_number
"value": "+9874556631"
},
{
"name": "sim_number_type", //sim_number_type
"value": "MSISDN"
},
{
"name": "last_connected_start", //last_connected_start
"value": "null"
},
{
"name": "last_connected_end", //last_connected_end
"value": "null"
},
{
"name": "last_connected_zone_id", //last_connected_zone_id
"value": "null"
},
{
"name": "last_connected_policy_group_id", //last_connected_policy_group_id
"value": "null"
},
{
"name": "enabled", //enabled
"value": "true"
},
{
"name": "network_id", //network_id
"value": "GmDR"
},
{
"name": "policy_group_id", //policy_group_id
"value": "sdfujl_pol"
},
{
"name": "created_date", //created_date
"value": "null"
},
{
"name": "sku", //sku
"value": "SDEDG001NW"
},
{
"name": "billing.billable", //billing.billable
"value": true
},
{
"name": "iccid", //iccid
"value": "54874552485455"
},
{
"name": "icc_id", //icc_id
"value": "id"
},
{
"name": "cellular_ip", //cellular_ip
"value": "null"
},
{
"name": "lock_imei", //lock_imei
"value": "true"
},
{
"name": "locked_imei", //locked_imei
"value": "true"
},
{
"name": "last_connected_mobile_network", //last_connected_mobile_network
"value": "xyz"
}
]
}
],
"resourceRelationship": [
{
"relationshipType": "never_connected", //status
"resource": {
"resourceCharacteristic": [
{
"name": "status", //status
"value": "never_connected"
},
{
"name": "bearer", //bearer
"value": "cellular"
}
]
}
}
]
}
]CASE 2 Unitary Test (Delete Device Interface)
This operation delete the interface inventory of device from Akamai.
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/resource/{id}url Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
| id | string | resource identifier (Interface ID) | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| operation | string | event operation example value: deviceInterface | Y |
| X-Asavie-Account-Id | string | Id of the account to operate in | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| id | string | Id of device | Y |
Request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/resource/d489e8c5-0956-4b42-ab5f-8153e01ad5eb?id=aa8b849f-da7c-4f70-8e00-4a28dda43fc5' \
--header 'X-Correlation-Id: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'client_id: abcde' \
--header 'client_secret: 12345' \
--header 'operation: deviceInterface' \
--header 'X-Asavie-Account-Id: a005e16a-2fc4-4320-a3fb-545ae52f5958'Response
Status Code 204CASE 3 Unitary Test (Create Device Interface)
This operation is to create the interface inventory of device at Akamai.
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/resourceurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| operation | string | event operation example value: deviceInterface | Y |
| X-Asavie-Account-Id | string | Id of the account to operate in | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| id | string | Id of device | Y |
Request
curl --location --request GET 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/resource?id=aa8b849f-da7c-4f70-8e00-4a28dda43fc5' \
--header 'X-Correlation-Id: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'client_id: abcde' \
--header 'client_secret: 12345' \
--header 'operation: deviceInterface' \
--header 'X-Asavie-Account-Id: a005e16a-2fc4-4320-a3fb-545ae52f5958' \
--header 'Content-Type: application/json' \
--data '{
"name": "Interface Name",
"resourceCharacteristic": [
{
"name": "account_id",
"value": "a005e16a-2fc4-4320-a3fb-545ae52f5958"
}
],
"activationFeature": [{
"featureCharacteristic": [
{
"name": "apn_id",
"value": "4534-3534-434"
},
{
"name": "apn_operator",
"value": "Operator"
},
{
"name": "interface_type",
"value": "type"
},
{
"name": "static_ip",
"value": "125.254.236.325"
},
{
"name": "access_ip",
"value": "125.254.236.325"
},
{
"name": "sim_number",
"value": "+9874556631"
},
{
"name": "sim_number_type",
"value": "MSISDN"
},
{
"name": "last_connected_start",
"value": "null"
},
{
"name": "last_connected_end",
"value": "null"
},
{
"name": "last_connected_zone_id",
"value": "null"
},
{
"name": "last_connected_policy_group_id",
"value": "null"
},
{
"name": "enabled",
"value": "true"
},
{
"name": "network_id",
"value": "GmDR"
},
{
"name": "policy_group_id",
"value": "sdfujl_pol"
},
{
"name": "created_date",
"value": "null"
},
{
"name": "sku",
"value": "SDEDG001NW"
},
{
"name": "billing.billable",
"value": true
},
{
"name": "iccid",
"value": "54874552485455"
},
{
"name": "icc_id",
"value": "id"
},
{
"name": "cellular_ip",
"value": "null"
},
{
"name": "lock_imei",
"value": "true"
},
{
"name": "locked_imei",
"value": "true"
},
{
"name": "last_connected_mobile_network",
"value": "xyz"
}
]
}],
"resourceRelationship": [
{
"relationshipType": "never_connected",
"resource": {
"resourceCharacteristic": [
{
"name": "status",
"value": "never_connected"
},
{
"name": "bearer",
"value": "cellular"
}
]
}
}
]
}'| name | type | description | required |
|---|---|---|---|
| name | string | name of the Interface | Y |
| resourceCharacteristic | array | A list of characteristics | N |
| resourceCharacteristic[].name | string | Note : Possible resourceCharacteristic names are : account_id. | N |
| resourceCharacteristic[].value | string | value of characteristics | N |
| activationFeature | array | Array of the interfaces of the device | N |
| activationFeature[].featureCharacteristic | array | A list of characteristics | N |
| activationFeature[].featureCharacteristic[].name | string | Note : Possible featureCharacteristic names are : apn_id (Required), apn_operator, interface_type (Required), static_ip, access_ip, sim_number (Required), sim_number_type (Required), last_connected_start, last_connected_end, last_connected_zone_id, last_connected_policy_group_id, enabled, network_id *Note: Optional when default network is chosen, else send the valid network ID policy_group_id, created_date, sku, billing.billable, iccid, icc_id, cellular_id, lock_imei, locked_imei, last_connected_mobile_network | Y* |
| activationFeature[].featureCharacteristic[].value | string | value of characteristic | N |
| resourceRelationship | array | If the device has the App installed, these are the details. | N |
| resourceRelationship[].relationshipType | string | type of relationship | N |
| resourceRelationship[].resource | object | A resource ref or value | N |
| resourceRelationship[].resource{}.resourceCharacteristic | array | A list of characteristics | N |
| resourceRelationship[].resource{}.resourceCharacteristic[].name | string | Note : Possible featureCharacteristic names are : status, bearer | N |
| resourceRelationship[].resource{}.resourceCharacteristic[].value | string | value of characteristic | N |
Response
{
"name": "Interface Name", //name
"id" : "d489e8c5-0956-4b42-ab5f-8153e01ad5eb", //id
"resourceCharacteristic": [
{
"name": "account_id", //account_id
"value": "a005e16a-2fc4-4320-a3fb-545ae52f5958"
}
],
"activationFeature": [{
"featureCharacteristic": [
{
"name": "apn_id", //apn_id
"value": "4534-3534-434"
},
{
"name": "apn_operator", //apn_operator
"value": "Operator"
},
{
"name": "interface_type", //interface_type
"value": "type"
},
{
"name": "static_ip", //static_ip
"value": "125.254.236.325"
},
{
"name": "access_ip", //access_ip
"value": "125.254.236.325"
},
{
"name": "sim_number", //sim_number
"value": "+9874556631"
},
{
"name": "sim_number_type", //sim_number_type
"value": "MSISDN"
},
{
"name": "last_connected_start", //last_connected_start
"value": "null"
},
{
"name": "last_connected_end", //last_connected_end
"value": "null"
},
{
"name": "last_connected_zone_id", //last_connected_zone_id
"value": "null"
},
{
"name": "last_connected_policy_group_id", //last_connected_policy_group_id
"value": "null"
},
{
"name": "enabled", //enabled
"value": "true"
},
{
"name": "network_id", //network_id
"value": "GmDR"
},
{
"name": "policy_group_id", //policy_group_id
"value": "sdfujl_pol"
},
{
"name": "created_date", //created_date
"value": "null"
},
{
"name": "sku", //sku
"value": "SDEDG001NW"
},
{
"name": "billing.billable", //billing.billable
"value": true
},
{
"name": "iccid", //iccid
"value": "54874552485455"
},
{
"name": "icc_id", //icc_id
"value": "id"
},
{
"name": "cellular_ip", //cellular_ip
"value": "null"
},
{
"name": "lock_imei", //lock_imei
"value": "true"
},
{
"name": "locked_imei", //locked_imei
"value": "true"
},
{
"name": "last_connected_mobile_network", //last_connected_mobile_network
"value": "xyz"
}
]
}],
"resourceRelationship": [
{
"relationshipType": "never_connected",//status
"resource": {
"resourceCharacteristic": [
{
"name": "status", //status
"value": "never_connected
},
{
"name": "bearer", //bearer
"value": "cellular"
}
]
}
}
]
}